Skip to content

Clarify in README that v0.9 and v1.0 are withdrawn#80

Merged
jmarinho merged 1 commit intoFirmwareHandoff:mainfrom
jmarinho:deprecate
Dec 15, 2025
Merged

Clarify in README that v0.9 and v1.0 are withdrawn#80
jmarinho merged 1 commit intoFirmwareHandoff:mainfrom
jmarinho:deprecate

Conversation

@jmarinho
Copy link
Contributor

@jmarinho jmarinho commented Nov 10, 2025

Update Readme:
- state that v1.0 is withdrawn
- set expectations for v2.0 release timeline

The version v.9 and v1.0 are withdrawn because products shipped
with a TL header checksum implementation that differed from what was
spec'd (implementations used sum-based checksum, whereas spec mandated
xor).

Change-Id: Ibff46e7d88fcec0b1f3352aa7cebd7f5a7204e47

stages during platform initialization.

Note that versions 0.9 and 1.0 of this specification were deprecated and should not be used for product development.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think all the changes should be in the status section below, which is no longer accurate at all. Also, those versions are withdrawn, not deprecated. I think you could also say this is due to a mismatch in the checksum algorithm in the spec versus implementations (at least in the commit message).

@jmarinho jmarinho force-pushed the deprecate branch 2 times, most recently from 2d71d89 to 6b8da54 Compare November 11, 2025 09:24
README.md Outdated
By the end of 2024, the spec will be considered stable and will be published
as version 1. From there on, backwards compatibility will be maintained.
As of November 2025, version 1.0 is withdrawn and should not be used.
Version 1.0 was withdrawn because products shipped with an TL header cheksum implementation that differed from the version 1.0 definition.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: s/an TL/a TL/

README.md Outdated
@@ -53,5 +55,8 @@ coreboot, TF-A and Tianocore. Once this is done we will review the result to see
if any serious flaws have come to light, meaning that changes are needed. If
so, these will be undertaken in each project.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like all the above paragraph can now be removed.

@harrisonmutai-arm
Copy link
Contributor

harrisonmutai-arm commented Dec 12, 2025

@jmarinho could you please add some details in the PR body? At the moment all I see is a change ID, which isn't particularly relevant on GitHub (unless I'm missing something). Just a comment about what the PR does and why, for the benefit of those who somehow end up here in future.

Update Readme:
- state that v1.0 is withdrawn
- set expectations for v2.0 release timeline

The version v.9 and v1.0 are withdrawn because products shipped
with a TL header checksum implementation that differed from what was
spec'd (implementations used sum-based checksum, whereas spec mandated
xor).

Change-Id: Ibff46e7d88fcec0b1f3352aa7cebd7f5a7204e47
Signed-off-by: Jose Marinho <jose.marinho@arm.com>
@jmarinho
Copy link
Contributor Author

@jmarinho could you please add some details in the PR body? At the moment all I see is a change ID, which isn't particularly relevant on GitHub (unless I'm missing something). Just a comment about what the PR does and why, for the benefit of those who somehow end up here in future.

Done

if any serious flaws have come to light, meaning that changes are needed. If
so, these will be undertaken in each project.
As of November 2025, version 1.0 is withdrawn and should not be used.
Version 1.0 was withdrawn because products shipped with a TL header cheksum implementation that differed from the version 1.0 definition.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: I think this file generally tries to stick to an 80 column limit.

@danh-arm danh-arm changed the title Clarify in README that v0.9 and v1.0 are deprecated Clarify in README that v0.9 and v1.0 are withdrawn Dec 15, 2025
@jmarinho jmarinho merged commit dfb62d8 into FirmwareHandoff:main Dec 15, 2025
2 checks passed
harrisonmutai-arm added a commit to harrisonmutai-arm/optee_os that referenced this pull request Feb 9, 2026
Update the transfer list library to implement specification version 2.0,
as versions 1.0 and 0.9 have been withdrawn [1]. The primary change is
switching the checksum calculation from an XOR sum to a byte-wise sum.
This aligns the implementation with the updated specification and with
behavior already used in existing deployments.

1. FirmwareHandoff/firmware_handoff#80

Signed-off-by: Harrison Mutai <harrison.mutai@arm.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants